// --------------------------------------------------------------------------------------------------------------------
// <copyright file="ATIResponse.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------

namespace Microsoft.Robotics.Hardware.Sensors.ATI
{
    /// <summary>
    /// A class that provides all the constants in a response from an ATI sensor
    /// Reference can be found at the following url
    /// </summary>
    /// https://microsoft.sharepoint.com/teams/Baker/Shared%20Documents/Reference%20documents/Hardware%20Manual/ATI/9610-05-1022%20Manual.pdf
    public class ATIResponse
    {
        /// <summary>
        /// Name of the XML node for force unit in use
        /// </summary>
        public const string ActiveForceUnitNodeName = "scfgfu";

        /// <summary>
        /// Name of the XML node for torque unit in use
        /// </summary>
        public const string ActiveTorqueUnitNodeName = "scfgtu";

        /// <summary>
        /// Name of the XML node for counts per force reading in use
        /// </summary>
        public const string ActiveCountsPerForceReadingNodeName = "cfgcpf";

        /// <summary>
        /// Name of the XML node for counts per torque reading in use
        /// </summary>
        public const string ActiveCountsPerTorqueReadingNodeName = "cfgcpt";

        /// <summary>
        /// Value for the XML node of force unit in Newton
        /// </summary>
        public const string ForceUnitNewtonXMLValue = "N";

        /// <summary>
        /// Value for the XML node of torque unit in Newton-Meter
        /// </summary>
        public const string TorqueUnitNewtonMeterXMLValue = "N-m";
    }
}
